how-to/command-line-quick-start refactor #1444

ElPaisano · 2023-01-24T20:17:49Z

Latest draft click here

Describe your changes

Addresses #1443 and #1440 - read issue descriptions

Hey reviewers 👋 discussion:

Not sure what the best name for this guide is, but I think it should relate to what the tutorial is about, and "IPFS Kubo Tutorial" is way too generic. Thoughts?

Files Changes

https://github.com/ipfs/ipfs-docs/pull/1444/files

Checklist before requesting a review

Passing the beta version of the Check Markdown links for modified files check. Action results can be viewed here.

Checklist before merging

Passing all required checks (The beta Check Markdown links for modified files check is not required)

2color · 2023-01-25T11:32:31Z

Step 4 of https://bafybeidvobdv5i3pjscvsityfe6kzpkaqmdze6jyk5irmzydmaf7yex2ea.on.fleek.co/how-to/command-line-quick-start/#interact-with-the-node-using-the-web-console is not working for me - when I try to copy the file over to the MFS that was added in step 8 of https://bafybeidvobdv5i3pjscvsityfe6kzpkaqmdze6jyk5irmzydmaf7yex2ea.on.fleek.co/how-to/command-line-quick-start/#take-your-node-online using its hash, I see Error: argument "dest" is required.

The command should be ipfs files cp /ipfs/QmabZ1pL9npKXJg8JGdMwQMJo2NCVy9yDVYjhiHK4LTJQH /meow.txt

You can think of the ipfs files cp command as similar to cp with the difference that / is the root of MFS.

2color · 2023-01-25T11:41:27Z

docs/how-to/command-line-quick-start.md


-You can explore other objects in the repository. In particular, the `quick-start` directory which shows example commands to try:
+   ```bash
+   ipfs cat /ipfs/QmYwAPJzv5CZsnA625s3Xf2nemtYgPpHdWEz79ojWnPbdG/readme


Probably time to:

Update this file and remove the alpha software warning

use a CidV1

@2color

RE use a CidV1:

Are you saying we should update this tutorial to use CIDv1 instead of CIDv0? Make sense to me.

Trying to dogfood our own docs here, I see https://docs.ipfs.tech/how-to/best-practices-for-ipfs-builders/#use-cidv1-for-future-proof-addressing-and-case-insenstive-contexts -> should we just add a step in to this telling the user to run ipfs add --cid-version 1 (this is probably a good opportunity for me to get more hands on with IPFS)

Also, seems like that comment could apply to all docs in the tutorial, so seems like we should create an issue to update tutorials to use CIDv1?

RE update the readme:

Created this PR ipfs/kubo#9590 pls take a look and lmk if that captures the suggested updates

docs/how-to/command-line-quick-start.md

2color · 2023-01-25T11:48:11Z

docs/install/ipfs-companion.md

@@ -7,17 +7,24 @@ description: The IPFS Companion browser extension allows you to interact with yo

 IPFS Companion allows you to interact with your IPFS node and the extended IPFS network through your browser. The add-on is available for Brave, Chrome, Edge, Firefox, and Opera. It enables support for `ipfs://` addresses, automatically loads websites and file paths from an IPFS gateway, allows you to easily import and share a file with IPFS, and more.

-IPFS Companion works in tandem with an IPFS node running on your local machine, so make sure you have a [node installed](ipfs-desktop.md) before installing this add-on.
+## Prerequsities


I like that you're adding this Prerequsities section. I'd note that you can still use IPFS companion without a local node though you lose some of the functionality.

For example, you can load websites with DNSLink via a gateway.

@lidel WDYT?

@2color updated the copy based on your point ^ https://github.com/ipfs/ipfs-docs/pull/1444/files#diff-4a2f396b026959f2b7e270fdba96eb753a21a68f5895eb3f4fd20e9666a7ec4fR12-R18

2color

This is overall a significant improvement

Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>

ElPaisano · 2023-01-25T20:00:00Z

Cheers @2color confirmed locally and updated the copy per #1444 (comment)

@2color

In (currently in progress), @2color pointed out that we should probably remove the alpha software warning in this file ipfs/ipfs-docs#1444 (comment) because the software is no longer in alpha (right?) @2color anything else you'd suggest updating here?

ElPaisano · 2023-01-26T23:11:23Z

@TMoMoreau Mo could I get a copy review on this PR? This is one of those pages in the docs that will probably be iterated on a few times, but this PR seems to improve some stuff and has tech approval

TMoMoreau · 2023-01-26T23:16:25Z

@ElPaisano Sure thing, I've actually already reviewed it, just forgot to actually leave the review, I'll give it another quick scan.

Also, I'm not sure who has the GitHub name t, but you've just @'ed them in your comment.

ElPaisano · 2023-01-26T23:18:52Z

@ElPaisano Sure thing, I've actually already reviewed it, just forgot to actually leave the review, I'll give it another quick scan.

Also, I'm not sure who has the GitHub name t, but you've just @'ed them in your comment.

@TMoMoreau cheers, just pushed a quick update for some typos / nits

Fixed the t lol

TMoMoreau

Looks good.

ElPaisano mentioned this pull request Jan 24, 2023

Move all the Kubo specific guides into the same category #1440

Closed

ElPaisano linked an issue Jan 24, 2023 that may be closed by this pull request

Move all the Kubo specific guides into the same category #1440

Closed

ElPaisano removed a link to an issue Jan 24, 2023

Move all the Kubo specific guides into the same category #1440

Closed

This was linked to issues Jan 24, 2023

Move all the Kubo specific guides into the same category #1440

Closed

how-to/command-line-quick-start refactor proposal #1443

Closed

ElPaisano requested review from 2color, lidel and TMoMoreau January 24, 2023 20:36

2color reviewed Jan 25, 2023

View reviewed changes

docs/how-to/command-line-quick-start.md Outdated Show resolved Hide resolved

2color reviewed Jan 25, 2023

View reviewed changes

docs/how-to/command-line-quick-start.md Outdated Show resolved Hide resolved

2color reviewed Jan 25, 2023

View reviewed changes

2color approved these changes Jan 25, 2023

View reviewed changes

ElPaisano and others added 5 commits January 25, 2023 11:22

how-to/command-line-quick-start refactor

e3f383a

nits

2f72f9b

Update subsection title

dc67450

Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>

Add note about default API port

66a00d4

Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>

address 2color feedback

5702866

ElPaisano force-pushed the 1440 branch from 61ea5d7 to 5702866 Compare January 25, 2023 19:43

ElPaisano mentioned this pull request Jan 25, 2023

Remove the alpha software warning in assets/init-doc/readme ipfs/kubo#9590

Closed

ElPaisano added this to the 1/20/22-1/20/27 milestone Jan 26, 2023

ElPaisano self-assigned this Jan 26, 2023

ElPaisano added the need/maintainers-input Needs input from the current maintainer(s) label Jan 26, 2023

ElPaisano removed the request for review from lidel January 26, 2023 23:09

Typos, nits

da000f6

TMoMoreau approved these changes Jan 26, 2023

View reviewed changes

ElPaisano merged commit 82da951 into ipfs:main Jan 27, 2023

ElPaisano added a commit to ElPaisano/ipfs-docs that referenced this pull request Jan 27, 2023

how-to/command-line-quick-start refactor (ipfs#1444)

bfa87c3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

how-to/command-line-quick-start refactor #1444

how-to/command-line-quick-start refactor #1444

ElPaisano commented Jan 24, 2023 •

edited

Loading

2color commented Jan 25, 2023

2color Jan 25, 2023

ElPaisano Jan 25, 2023 •

edited

Loading

2color Jan 25, 2023

ElPaisano Jan 25, 2023

2color left a comment

ElPaisano commented Jan 25, 2023 •

edited

Loading

ElPaisano commented Jan 26, 2023 •

edited

Loading

TMoMoreau commented Jan 26, 2023

ElPaisano commented Jan 26, 2023

TMoMoreau left a comment

how-to/command-line-quick-start refactor #1444

how-to/command-line-quick-start refactor #1444

Conversation

ElPaisano commented Jan 24, 2023 • edited Loading

Latest draft click here

Describe your changes

Hey reviewers 👋 discussion:

Files Changes

Checklist before requesting a review

Checklist before merging

2color commented Jan 25, 2023

2color Jan 25, 2023

Choose a reason for hiding this comment

ElPaisano Jan 25, 2023 • edited Loading

Choose a reason for hiding this comment

RE use a CidV1:

RE update the readme:

2color Jan 25, 2023

Choose a reason for hiding this comment

ElPaisano Jan 25, 2023

Choose a reason for hiding this comment

2color left a comment

Choose a reason for hiding this comment

ElPaisano commented Jan 25, 2023 • edited Loading

ElPaisano commented Jan 26, 2023 • edited Loading

TMoMoreau commented Jan 26, 2023

ElPaisano commented Jan 26, 2023

TMoMoreau left a comment

Choose a reason for hiding this comment

ElPaisano commented Jan 24, 2023 •

edited

Loading

ElPaisano Jan 25, 2023 •

edited

Loading

ElPaisano commented Jan 25, 2023 •

edited

Loading

ElPaisano commented Jan 26, 2023 •

edited

Loading